home *** CD-ROM | disk | FTP | other *** search
/ The Epic Collection 3 / Epic Collection 3, The (1997)(Epic Marketing)[!].iso / internet / misc / indexmaker / indexmaker.doc < prev    next >
Text File  |  1996-09-08  |  6KB  |  198 lines
  1.                                 ***************
  2.                                 * Index Maker *
  3.                                 ***************
  4.  
  5.  
  6. Introduction
  7. ------------
  8.  
  9. If you want to understand what is this program just imagine the
  10. following situation :
  11.  
  12. You go on holidays for 3 or 4 weeks. But during this period
  13. Aminet goes on receiving new archives. So when you go back
  14. you have a big problem : how to find these archives in the big
  15. Aminet index ?
  16.  
  17. Index Maker is the solution. You can use it to extract from the
  18. index only the archives which have been published during a
  19. chosen period.
  20.  
  21. So if you don't want to use Aminet indexes you can delete Index Maker
  22. right now, I won't hurt you ;)
  23.  
  24. Features
  25. --------
  26.  
  27. Here comes the list of Index Maker :
  28.  
  29. - Fast
  30.  
  31. - AST support : you can extract some CD ROM indexes from the global CD index
  32.  
  33. - Automatic detection of fields' size, based on headers
  34.  
  35. - Very simple to use
  36.  
  37.  
  38. Installation
  39. ------------
  40.  
  41. I think I could say it is very easy. Just put Index Maker where you want. :-))
  42.  
  43.  
  44. Required
  45. --------
  46.  
  47. Amiga 4000 T with 68060 or PowerPC, 20 MB of free RAM and 2 hard drives of 1 GB ;-)
  48.  
  49.  
  50. Hey I was joking ! Don't be afraid !
  51.  
  52. Seriousely it should work on every Amiga with Dos.library V37 or newer and
  53. some memory (1 or 2 MB should be sufficient but I'm not sure). I hope
  54. it will also work on A1200+/1300.
  55.  
  56. You also need an Aminet Index with 5 fields of any size (network or CD ROM).
  57.  
  58. WARNING : Some internet sites like ftp.luth.se still have 4 fields indexes.
  59.           Index Maker WON'T work on these indexes.
  60.  
  61.  
  62. Usage
  63. -----
  64.  
  65. From CLI : Usage : Index Maker -in <Index name> [ -out <Output file name> ]
  66.                                -eq/gt/lt/ge/le/ne <Age>
  67.  
  68. Hum....I think I should explain these things :
  69.  
  70. * "Index name" is the name of the Index file with its path (example : Work:MyIndex).
  71.   This argument MUST be given, or an error message will be displayed.
  72.  
  73. * "Output file name" is the name of the file which will contain the new index
  74.   with its path (example : Ram:MessyASCIIFile). If you don't specify it Index Maker will
  75.   use standard output (generally the screen).
  76.  
  77. * "Age" is the age limit of the archives, which will say if they can be included or not.
  78.   The possible keywords are :
  79.     -eq : archives'age must be equal to "Age"
  80.     -gt : archives'age must be greater than "Age"
  81.     -lt : archives'age must be lesser than "Age"
  82.     -ge : archives'age must be greater or equal than "Age"
  83.     -le : archives'age must be lesser or equal than "Age"
  84.     -ne : archives'age musn't be equal to "Age"
  85.  
  86.  
  87. Examples
  88. --------
  89.  
  90. * Conversion of the file Work:Tmp/Index to extract news from the last 4 weeks :
  91.  
  92.         IndexMaker -in Work:Tmp/Index7 -le 4
  93.  
  94. * The same but to the file Ram:InputFile :
  95.  
  96.         IndexMaker -in Work:Tmp/Index -out Ram:InputFile -le 4
  97.  
  98. * And now a RECENT index :
  99.  
  100.         IndexMaker -in Work:Tmp/Index -out Ram:InputFile -eq 0
  101.  
  102.  
  103. History
  104. -------
  105.  
  106. November 1995           Version 1.0         First version. All keywords implemented,
  107.                                             just a little problem of memory allocation
  108.                                             to be fixed.
  109.                                             Version not released.
  110.  
  111. March 1996              Version 1.1         I've had a lot of personal problems so this baby's
  112.                                             been sleeping on my hard drive for 4 months.
  113.                                             Now I have fixed remaining bugs. Seems to work
  114.                                             fine now :)
  115.                                             First Aminet release.
  116.  
  117.  
  118. Tests
  119. -----
  120.  
  121. Index Maker has been created and tested on an Amiga 1200 with a Blizzard 1220/4 expansion
  122. card. Here are two examples of its speed :
  123.  
  124.  File                           Length                  Time
  125.  ----                           ------                  ----
  126.  
  127.  Aminet Index (2 March 96)      1874452 bytes           10 seconds
  128.  The same but different test                            10 seconds
  129.  AST CD Index (2-9)             2058033                 13 seconds
  130.  
  131. The command lines are :
  132.  
  133. IndexMaker -in Netindex -out ram:recent -eq 0
  134. IndexMaker -in Netindex -out hollidays -le 4
  135. IndexMaker -in CdIndex -out ram:cd7 -eq 7
  136.  
  137.  
  138. Disclaimer
  139. ----------
  140.  
  141. Index Maker has been tested on my machine (see tests) and you use it at your own risks.
  142. I can't be responsible for lost data due to its usage. With used algorithms it shouldn't
  143. make damages.
  144.  
  145.  
  146. Distribution
  147. ------------
  148.  
  149. Index Maker is GIFTWARE. If you like it and use it you can send me something, according
  150. to the value you give to Index Maker (if you send me money please send me cash only).
  151.  
  152. I keep a copyright on this program. Public domain organisations and magazines
  153. are allowed to distribute it if the archive remains intact (don't hack Index Maker) and
  154. if the price of the support is normal. France Festival Distribution WILL NEVER
  155. BE ALLOWED TO DISTRIBUTE THIS PROGRAM.
  156.  
  157.  
  158. Of course Aminet is allowed to distribute it and to put it on an Aminet CD ROM :-)
  159.  
  160.  
  161. Author
  162. ------
  163.  
  164.  
  165. Index Maker has been created by :
  166.  
  167. Franck Aniere
  168. 30 Rue Jean Bouin
  169. 93220 GAGNY (France)
  170.  
  171. E-Mail : aniere@univ-mlv.fr
  172.  
  173. WEB    : http://massena.univ-mlv.fr/~aniere (in French for the moment but try my links ;))
  174.  
  175. IRC    : nickname FSA on the channel #amigafr (sometimes #amiga, #xfiles and #xfilesfr)
  176.  
  177. You can join me for any suggestions, bug reports, enforcer hits (I have no MMU)
  178. or just to tell me what do you think of it.
  179.  
  180. If you find a bug or if Index Maker doesn't work with your files contact me and and I'll
  181. fix the problem quickly. Instead of writting another program if mine doesn't work
  182. with you just tell me what do you want in it and I'll see if I add this feature.
  183.  
  184.  
  185. Thanks
  186. ------
  187.  
  188. Arne Meyer for AST, the greatest Aminet search tool (I use it everyday).
  189.  
  190. My friends of #amigafr, for various reasons
  191.  
  192. Amiga creators, for such a wonderful computer.
  193.  
  194.  
  195. To do
  196. -----
  197.  
  198. Well, I think I will rewrite it when I will have a little time.